fix(html): hint when custom theme uses unknown Handlebars helpers (#2834)#3111
Closed
leno23 wants to merge 5 commits into
Closed
fix(html): hint when custom theme uses unknown Handlebars helpers (#2834)#3111leno23 wants to merge 5 commits into
leno23 wants to merge 5 commits into
Conversation
When rendering fails with "Helper not found" (e.g. `fa` from a theme index.hbs copied from a newer mdBook), append guidance to copy templates from the same mdBook version used to build. Fixes rust-lang#2834 Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
When a custom
theme/index.hbsreferences built-in helpers (fa,toc,resource) but the build fails with Handlebars "Helper not found", append actionable guidance: copy templates from the same mdBook version used to build (e.g. viamdbook init), not from a different release or branch.This addresses confusion in #2834 where copying
index.hbsfrom source/docs without matching the installed mdBook version produced an opaque error.Fixes #2834
Test plan
cargo test -p mdbook-html render_hintcargo test -p mdbook --test testsuite theme::